Summary

Fully Qualified Name:	Laminas\Crypt\PublicKey\RsaOptions
Extends:	AbstractOptions

Description

Methods

Name	Description	Defined By
__construct()	Constructor	AbstractOptions
__get()	Get a configuration property	AbstractOptions
__isset()	Test if a configuration property is null	AbstractOptions
__set()	Set a configuration property	AbstractOptions
__unset()	Set a configuration property to NULL	AbstractOptions
generateKeys()	Generate new private/public key pair	RsaOptions
getBinaryOutput()	Get the value of binary output	RsaOptions
getHashAlgorithm()	Get hash algorithm	RsaOptions
getOpensslPadding()	Get the OPENSSL padding	RsaOptions
getOpensslSignatureAlgorithm()		RsaOptions
getPassPhrase()	Get pass phrase	RsaOptions
getPrivateKey()	Get private key	RsaOptions
getPublicKey()	Get public key	RsaOptions
setBinaryOutput()	Enable/disable the binary output	RsaOptions
setFromArray()	Set one or more configuration properties	AbstractOptions
setHashAlgorithm()	Set hash algorithm	RsaOptions
setOpensslPadding()	Set the OPENSSL padding	RsaOptions
setPassPhrase()	Set pass phrase	RsaOptions
setPrivateKey()	Set private key	RsaOptions
setPublicKey()	Set public key	RsaOptions
toArray()	Cast to array	AbstractOptions

Method Details

__construct()

Constructor

Parameter Name	Type	Description
$options	array|\Traversable|null

Returns:

__get()

Get a configuration property

Parameter Name	Type	Description
$key	string

Returns: mixed

__isset()

Test if a configuration property is null

Parameter Name	Type	Description
$key	string

Returns: bool

__set()

Set a configuration property

Parameter Name	Type	Description
$key	string
$value	mixed

Returns: void

__unset()

Set a configuration property to NULL

Parameter Name	Type	Description
$key	string

Returns: void

generateKeys()

Generate new private/public key pair

Parameter Name	Type	Description
$opensslConfig	array

Returns: \RsaOptions Provides a fluent interface

getBinaryOutput()

Get the value of binary output

Returns: bool

getHashAlgorithm()

Get hash algorithm

Returns: string

getOpensslPadding()

Get the OPENSSL padding

Returns: int|null

getOpensslSignatureAlgorithm()

Returns: void

getPassPhrase()

Get pass phrase

Returns: string

getPrivateKey()

Get private key

Returns: null|\Rsa\PrivateKey

getPublicKey()

Get public key

Returns: null|\Rsa\PublicKey

setBinaryOutput()

Enable/disable the binary output

Parameter Name	Type	Description
$value	bool

Returns: \RsaOptions Provides a fluent interface

setFromArray()

Set one or more configuration properties

Parameter Name	Type	Description
$options	array|\Traversable|\AbstractOptions

Returns: \AbstractOptions Provides fluent interface

setHashAlgorithm()

Set hash algorithm

Parameter Name	Type	Description
$hash	string

Returns: \RsaOptions Provides a fluent interface

setOpensslPadding()

Set the OPENSSL padding

Parameter Name	Type	Description
$opensslPadding	int|null

Returns: \RsaOptions Provides a fluent interface

setPassPhrase()

Set pass phrase

Parameter Name	Type	Description
$phrase	string

Returns: \RsaOptions Provides a fluent interface

setPrivateKey()

Set private key

Parameter Name	Type	Description
$key	\Rsa\PrivateKey

Returns: \RsaOptions Provides a fluent interface

setPublicKey()

Set public key

Parameter Name	Type	Description
$key	\Rsa\PublicKey

Returns: \RsaOptions Provides a fluent interface

toArray()

Cast to array

Returns: array